Skip to main content

Quick Start

ALPHA VERSION

This SDK is not intended for use at this stage.
It is in early alpha development, unstable, and subject to major breaking changes.
Do not use this SDK in any production, staging, or testnet environments.
We strongly advise against integrating or deploying this code until a stable release is announced.

Welcome to the AssemblyScript Stylus SDK - a comprehensive development toolkit for creating Arbitrum Stylus smart contracts using TypeScript syntax, transpiled to AssemblyScript and compiled to WebAssembly for near-native execution speeds.

What is AssemblyScript Stylus SDK?​

The AssemblyScript Stylus SDK is a complete development framework that allows developers to write smart contracts using familiar TypeScript decorators and syntax. Stylus is Arbitrum's next-generation smart contract platform that enables developers to write contracts in languages other than Solidity, compiling them to WebAssembly for superior performance and gas efficiency.

Requirements​

  • Node.js >= 18.x
  • AssemblyScript >= 0.27.x
  • cargo stylus (Rust CLI tool for Stylus validation and deployment)

Installation​

Install the CLI globally to get started:

npm install -g as-stylus

Generate a New Project​

Create a new contract project with built-in scaffolding:

as-stylus generate my-contract
cd my-contract

This creates a complete project structure with:

  • Contract template
  • Configuration files
  • Package dependencies
  • Build scripts

Your First Contract​

The generator creates a simple counter contract for you:

@Contract
export class Counter {
  static counter: U256;

  constructor() {
    counter = U256Factory.create();
  }

  @External
  static increment(): void {
    const delta: U256 = U256Factory.fromString("1");
    counter = counter.add(delta);
  }

  @External
  static decrement(): void {
    const delta: U256 = U256Factory.fromString("1");
    counter = counter.sub(delta);
  }

  @View
  static get(): U256 {
    return counter;
  }
}

Build and Deploy​

Compile your contract to WebAssembly and validate it for Stylus:

as-stylus compile contract.ts --endpoint <RPC_URL>

Deploy to Arbitrum:

npm run deploy contract.ts --private-key <PRIVATE_KEY> --endpoint <RPC_URL> --constructor-args <constructor-args...>"

Clean Artifacts​

npm run clean

This command will remove all the artifact folder.

Next Steps​

Ready to dive deeper? Check out the Project Breakdown to understand the SDK's architecture and components, or explore our comprehensive guides: